home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / include / glib-2.0 / glib / gnode.h < prev    next >
Encoding:
C/C++ Source or Header  |  2006-04-25  |  5.6 KB  |  171 lines
  1. /* GLIB - Library of useful routines for C programming
  2.  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
  3.  *
  4.  * This library is free software; you can redistribute it and/or
  5.  * modify it under the terms of the GNU Lesser General Public
  6.  * License as published by the Free Software Foundation; either
  7.  * version 2 of the License, or (at your option) any later version.
  8.  *
  9.  * This library is distributed in the hope that it will be useful,
  10.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the GNU
  12.  * Lesser General Public License for more details.
  13.  *
  14.  * You should have received a copy of the GNU Lesser General Public
  15.  * License along with this library; if not, write to the
  16.  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17.  * Boston, MA 02111-1307, USA.
  18.  */
  19.  
  20. /*
  21.  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22.  * file for a list of people on the GLib Team.  See the ChangeLog
  23.  * files for a list of changes.  These files are distributed with
  24.  * GLib at ftp://ftp.gtk.org/pub/gtk/. 
  25.  */
  26.  
  27. #ifndef __G_NODE_H__
  28. #define __G_NODE_H__
  29.  
  30. #include <glib/gmem.h>
  31.  
  32. G_BEGIN_DECLS
  33.  
  34. typedef struct _GNode        GNode;
  35.  
  36. /* Tree traverse flags */
  37. typedef enum
  38. {
  39.   G_TRAVERSE_LEAVES     = 1 << 0,
  40.   G_TRAVERSE_NON_LEAVES = 1 << 1,
  41.   G_TRAVERSE_ALL        = G_TRAVERSE_LEAVES | G_TRAVERSE_NON_LEAVES,
  42.   G_TRAVERSE_MASK       = 0x03,
  43.   G_TRAVERSE_LEAFS      = G_TRAVERSE_LEAVES,
  44.   G_TRAVERSE_NON_LEAFS  = G_TRAVERSE_NON_LEAVES
  45. } GTraverseFlags;
  46.  
  47. /* Tree traverse orders */
  48. typedef enum
  49. {
  50.   G_IN_ORDER,
  51.   G_PRE_ORDER,
  52.   G_POST_ORDER,
  53.   G_LEVEL_ORDER
  54. } GTraverseType;
  55.  
  56. typedef gboolean    (*GNodeTraverseFunc)    (GNode           *node,
  57.                          gpointer    data);
  58. typedef void        (*GNodeForeachFunc)    (GNode           *node,
  59.                          gpointer    data);
  60. typedef gpointer    (*GCopyFunc)            (gconstpointer  src,
  61.                                                  gpointer       data);
  62.  
  63. /* N-way tree implementation
  64.  */
  65. struct _GNode
  66. {
  67.   gpointer data;
  68.   GNode      *next;
  69.   GNode      *prev;
  70.   GNode      *parent;
  71.   GNode      *children;
  72. };
  73.  
  74. #define     G_NODE_IS_ROOT(node)    (((GNode*) (node))->parent == NULL && \
  75.                  ((GNode*) (node))->prev == NULL && \
  76.                  ((GNode*) (node))->next == NULL)
  77. #define     G_NODE_IS_LEAF(node)    (((GNode*) (node))->children == NULL)
  78.  
  79. void     g_node_push_allocator  (GAllocator       *allocator);
  80. void     g_node_pop_allocator   (void);
  81. GNode*     g_node_new        (gpointer       data);
  82. void     g_node_destroy        (GNode          *root);
  83. void     g_node_unlink        (GNode          *node);
  84. GNode*   g_node_copy_deep       (GNode            *node,
  85.                  GCopyFunc         copy_func,
  86.                  gpointer          data);
  87. GNode*   g_node_copy            (GNode            *node);
  88. GNode*     g_node_insert        (GNode          *parent,
  89.                  gint           position,
  90.                  GNode          *node);
  91. GNode*     g_node_insert_before    (GNode          *parent,
  92.                  GNode          *sibling,
  93.                  GNode          *node);
  94. GNode*   g_node_insert_after    (GNode            *parent,
  95.                  GNode            *sibling,
  96.                  GNode            *node); 
  97. GNode*     g_node_prepend        (GNode          *parent,
  98.                  GNode          *node);
  99. guint     g_node_n_nodes        (GNode          *root,
  100.                  GTraverseFlags       flags);
  101. GNode*     g_node_get_root    (GNode          *node);
  102. gboolean g_node_is_ancestor    (GNode          *node,
  103.                  GNode          *descendant);
  104. guint     g_node_depth        (GNode          *node);
  105. GNode*     g_node_find        (GNode          *root,
  106.                  GTraverseType       order,
  107.                  GTraverseFlags       flags,
  108.                  gpointer       data);
  109.  
  110. /* convenience macros */
  111. #define g_node_append(parent, node)                \
  112.      g_node_insert_before ((parent), NULL, (node))
  113. #define    g_node_insert_data(parent, position, data)        \
  114.      g_node_insert ((parent), (position), g_node_new (data))
  115. #define    g_node_insert_data_before(parent, sibling, data)    \
  116.      g_node_insert_before ((parent), (sibling), g_node_new (data))
  117. #define    g_node_prepend_data(parent, data)            \
  118.      g_node_prepend ((parent), g_node_new (data))
  119. #define    g_node_append_data(parent, data)            \
  120.      g_node_insert_before ((parent), NULL, g_node_new (data))
  121.  
  122. /* traversal function, assumes that `node' is root
  123.  * (only traverses `node' and its subtree).
  124.  * this function is just a high level interface to
  125.  * low level traversal functions, optimized for speed.
  126.  */
  127. void     g_node_traverse    (GNode          *root,
  128.                  GTraverseType       order,
  129.                  GTraverseFlags       flags,
  130.                  gint           max_depth,
  131.                  GNodeTraverseFunc func,
  132.                  gpointer       data);
  133.  
  134. /* return the maximum tree height starting with `node', this is an expensive
  135.  * operation, since we need to visit all nodes. this could be shortened by
  136.  * adding `guint height' to struct _GNode, but then again, this is not very
  137.  * often needed, and would make g_node_insert() more time consuming.
  138.  */
  139. guint     g_node_max_height     (GNode *root);
  140.  
  141. void     g_node_children_foreach (GNode          *node,
  142.                   GTraverseFlags   flags,
  143.                   GNodeForeachFunc func,
  144.                   gpointer       data);
  145. void     g_node_reverse_children (GNode          *node);
  146. guint     g_node_n_children     (GNode          *node);
  147. GNode*     g_node_nth_child     (GNode          *node,
  148.                   guint           n);
  149. GNode*     g_node_last_child     (GNode          *node);
  150. GNode*     g_node_find_child     (GNode          *node,
  151.                   GTraverseFlags   flags,
  152.                   gpointer       data);
  153. gint     g_node_child_position     (GNode          *node,
  154.                   GNode          *child);
  155. gint     g_node_child_index     (GNode          *node,
  156.                   gpointer       data);
  157.  
  158. GNode*     g_node_first_sibling     (GNode          *node);
  159. GNode*     g_node_last_sibling     (GNode          *node);
  160.  
  161. #define     g_node_prev_sibling(node)    ((node) ? \
  162.                      ((GNode*) (node))->prev : NULL)
  163. #define     g_node_next_sibling(node)    ((node) ? \
  164.                      ((GNode*) (node))->next : NULL)
  165. #define     g_node_first_child(node)    ((node) ? \
  166.                      ((GNode*) (node))->children : NULL)
  167.  
  168. G_END_DECLS
  169.  
  170. #endif /* __G_NODE_H__ */
  171.